/*
    simplecookbook  -  simplecookbook.database.IDataBase.java
                             -------------------
    begin                : 08/10/2008
    copyright            : (C) 2008 by cristovao
    email                : cristovao.wollieson@gmail.com
 ***************************************************************************/

/*
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful, but   *
 *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   General Public License for more details.                              *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,   *
 *   MA  02111-1307 USA                                                    *
 ***************************************************************************/

/**
 * Pacote responsavel por controla o banco de dados
 * 
 * @author cristovao
 */
package org.ybacoby.simplecookbook.database;

import java.sql.ResultSet;

import org.ybacoby.simplecookbook.exception.SimpleCookBookException;



/**
 * Interface que possui controle do banco de dados no sistema
 * 
 * @author cristovao
 *
 */
public interface IDataBase {

	/**
	 * Metodo usado para conectar ao banco de dados
	 * 
	 * @throws ClientException Caso a conexao nao seja efetuada com sucesso
	 */
	public void connectDataBase() throws SimpleCookBookException;
	
	/**
	 * Metodo destinado a fechar a conexao com o banco de dados
	 *  
	 * @throws ClientException Caso nem seja possivel desconectar
	 */
	public void closerDataBase() throws SimpleCookBookException;
	
	/**
	 * Utilizacao para a insercao de dados no banco de dados
	 * ao qual nao retorna nenhum valor
	 * 
	 * @param sql O codigo SQL para realizar a INSERCAO
	 * @throws ClientException Caso ocorra algum erro referente ao SQL introduzido
	 */
	public void insertSqlDatabase(String sql) throws SimpleCookBookException;
	
	/**
	 * Serve para buscar algo que esteja no banco de dados, este no caso
	 * possui retorno de valores
	 * 
	 * @param sql O codigo SQL usado para se fazer pesquisa no banco de dados
	 * @return Um objeto do tipo ResultSet com todos os dados buscados na tabela
	 * @throws ClientException
	 */
	public ResultSet selectSqlDatabase(String sql) throws SimpleCookBookException;
	
	/**
	 * Tem como objetivo retornar o total de itens que foram cadastrados no banco de dados
	 * em uma dada tabela
	 * 
	 * @param tabela A tabela que sera consultada para saber quantos itens cadastrados
	 * @return Um valor que indica a quantidade de itens na tabela
	 * @throws ClientException Caso ocorra algum erro no sql
	 */
	public int totalItensDataSql(EnumTabelaDataBase tabela) throws SimpleCookBookException;
	
	/**
	 * Tem como principal finalidade retornar a data atual assim como
	 * o tempo para que possa ser alocado no banco de dados, de forma
	 * que reflita o mesmo banco que esta sendo usado
	 * 
	 * @return A data atual em String
	 * @throws ClientException Caso nao seja possivel retornar o valor
	 */
	public String sqlDataTime() throws SimpleCookBookException;
}
